Add docs for new API
authorMatthias Clasen <mclasen@redhat.com>
Thu, 17 Oct 2013 03:35:55 +0000 (23:35 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Thu, 17 Oct 2013 03:45:23 +0000 (23:45 -0400)
gtk/gtkapplication.c

index 8eb05c99d24bbfd9cddea62c84a2c4a1963d44af..ccd49ec5f1c7087433b13fd1cc72c26c9fda9f90 100644 (file)
@@ -2055,6 +2055,18 @@ gtk_application_foreach_accel_keys (GtkApplication           *application,
   accels_foreach_key (&application->priv->accels, window, callback, user_data);
 }
 
+/**
+ * gtk_application_list_action_descriptions:
+ * @application: a #GtkApplication
+ *
+ * Lists the detailed action names which have associated accelerators.
+ * See gtk_application_set_accels_for_action().
+ *
+ * Returns: (transfer full): a %NULL-terminated array of strings,
+ *     free with g_strfreev() when done
+ *
+ * Since: 3.12
+ */
 gchar **
 gtk_application_list_action_descriptions (GtkApplication *application)
 {
@@ -2106,6 +2118,20 @@ normalise_detailed_name (const gchar *detailed_action_name)
   return action_and_target;
 }
 
+/**
+ * gtk_application_set_accels_for_action:
+ * @application: a #GtkApplication
+ * @detailed_action_name: a detailed action name, specifying and action
+ *     and target to associate accelerators with
+ * @accels: a list of accelerators in the format understood by
+ *     gtk_accelerator_parse()
+ *
+ * Sets one or more keyboard accelerator that will trigger the
+ * given action. The first item in @accels will be the primary 
+ * accelerator, which may be displayed in the UI.
+ *
+ * Since: 3.12
+ */
 void
 gtk_application_set_accels_for_action (GtkApplication      *application,
                                        const gchar         *detailed_action_name,
@@ -2123,6 +2149,20 @@ gtk_application_set_accels_for_action (GtkApplication      *application,
   g_free (action_and_target);
 }
 
+/**
+ * gtk_application_get_accels_for_action:
+ * @application: a #GtkApplication
+ * @detailed_action_name: a detailed action name, specifying and action
+ *     and target to obtain accelerators for
+ *
+ * Gets the accelerators that are currently associated with
+ * the given action.
+ *
+ * Returns: (transfer full): accelerators for @detailed_action_name, as
+ *     a %NULL-terminated array. Free with g_strfreev() when no longer needed
+ *
+ * Since: 3.12
+ */
 gchar **
 gtk_application_get_accels_for_action (GtkApplication *application,
                                        const gchar    *detailed_action_name)